IntelliJ Platform Gradle Plugin/org.jetbrains.intellij.platform.gradle.tasks/VerifyPluginStructureTask

VerifyPluginStructureTask

@CacheableTask

abstract class VerifyPluginStructureTask : DefaultTask, SandboxAware

Validates completeness and contents of plugin.xml descriptors as well as plugin archive structure.

See also

Plugin Configuration File

TODO: Use Reporting for handling verification report output? See: https://docs.gradle.org/current/dsl/org.gradle.api.reporting.Reporting.html

Constructors

VerifyPluginStructureTask

constructor()

Types

object Companion : Registrable

Properties

@get:Internal

var enabled: Boolean

hasCustomActions

val hasCustomActions: Boolean

@get:Input

abstract val ignoreFailures: Property<Boolean>

Specifies whether the build should fail when the verifications performed by this task fail.

ignoreUnacceptableWarnings

@get:Input

abstract val ignoreUnacceptableWarnings: Property<Boolean>

Specifies whether the build should fail when the verifications performed by this task emit unacceptable warnings.

@get:Input

abstract val ignoreWarnings: Property<Boolean>

Specifies whether the build should fail when the verifications performed by this task emit warnings.

impliesSubProjects

var impliesSubProjects: Boolean

intelliJPlatformConfiguration

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val intelliJPlatformConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM configuration with the IntelliJ Platform dependency added. It should not be directly accessed.

intelliJPlatformPluginConfiguration

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val intelliJPlatformPluginConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM_PLUGIN_DEPENDENCY configuration with the optional custom IntelliJ Platform plugins dependencies added. It should not be directly accessed.

@get:Internal

open val platformPath: Path

Provides access to the IntelliJ Platform dependency artifact path.

pluginDirectory

@get:InputDirectory

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val pluginDirectory: DirectoryProperty

The location of the built plugin file which will be used for verification.

@get:Internal

open val productInfo: ProductInfo

Provides information about the IntelliJ Platform product. The information is retrieved from the product-info.json file in the IntelliJ Platform directory.

sandboxConfigDirectory

@get:Internal

abstract val sandboxConfigDirectory: DirectoryProperty

A configuration directory located within the sandboxDirectory.

sandboxDirectory

@get:Internal

abstract val sandboxDirectory: DirectoryProperty

The directory containing content read and produced by the running IDE.

sandboxLogDirectory

@get:Internal

abstract val sandboxLogDirectory: DirectoryProperty

A log directory located within the sandboxDirectory.

sandboxPluginsDirectory

@get:Internal

abstract val sandboxPluginsDirectory: DirectoryProperty

A plugins directory located within the sandboxDirectory.

@get:Internal

abstract val sandboxSuffix: Property<String>

Represents the suffix used i.e., for test-related tasks.

sandboxSystemDirectory

@get:Internal

abstract val sandboxSystemDirectory: DirectoryProperty

A system directory located within the sandboxDirectory.

val state: TaskStateInternal

val timeout: Property<Duration>

Functions

acceptServiceReferences

open override fun acceptServiceReferences(serviceReferences: MutableSet<ServiceReferenceSpec>)

appendParallelSafeAction

open override fun appendParallelSafeAction(action: Action<in Task>)

open operator override fun compareTo(other: Task): Int

open override fun configure(closure: Closure<Any>): Task

open override fun dependsOn(vararg paths: Any): Task

open override fun doFirst(action: Closure<Any>): Task

open override fun doFirst(action: Action<in Task>): Task

open override fun doFirst(actionName: String, action: Action<in Task>): Task

open override fun doLast(action: Closure<Any>): Task

open override fun doLast(action: Action<in Task>): Task

open override fun doLast(actionName: String, action: Action<in Task>): Task

doNotTrackState

open override fun doNotTrackState(reasonNotToTrackState: String)

open override fun finalizedBy(vararg paths: Any): Task

open override fun getActions(): MutableList<Action<in Task>>

open override fun getAnt(): AntBuilder

getAsDynamicObject

@Internal

open override fun getAsDynamicObject(): DynamicObject

@Internal

open override fun ~~getConvention~~(): Convention

open override fun getDependsOn(): MutableSet<Any>

open override fun getDescription(): String?

getDestroyables

open override fun getDestroyables(): TaskDestroyables

open override fun getDidWork(): Boolean

open override fun getExtensions(): ExtensionContainer

open override fun getFinalizedBy(): TaskDependency

open override fun getGroup(): String?

getIdentityPath

open override fun getIdentityPath(): Path

open override fun getInputs(): TaskInputsInternal

getLifecycleDependencies

@Internal

open override fun getLifecycleDependencies(): TaskDependencyInternal

open override fun getLocalState(): TaskLocalState

open override fun getLogger(): Logger

open override fun getLogging(): LoggingManager

getMustRunAfter

open override fun getMustRunAfter(): TaskDependency

open override fun getName(): String

open override fun getOnlyIf(): Spec<in TaskInternal>

open override fun getOutputs(): TaskOutputsInternal

open override fun getPath(): String

open override fun getProject(): Project

getReasonNotToTrackState

open override fun getReasonNotToTrackState(): Optional<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open override fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getRequiredServices

open override fun getRequiredServices(): TaskRequiredServices

getSharedResources

open override fun getSharedResources(): MutableList<ResourceLock>

getShouldRunAfter

open override fun getShouldRunAfter(): TaskDependency

getStandardOutputCapture

open override fun getStandardOutputCapture(): StandardOutputCapture

open override fun getTaskActions(): MutableList<InputChangesAwareTaskAction>

getTaskDependencies

open override fun getTaskDependencies(): TaskDependencyInternal

getTaskIdentity

open override fun getTaskIdentity(): TaskIdentity<*>

getTemporaryDir

open override fun getTemporaryDir(): File

getTemporaryDirFactory

open override fun getTemporaryDirFactory(): Factory<File>

open override fun hasProperty(propertyName: String): Boolean

open override fun hasTaskActions(): Boolean

isCompatibleWithConfigurationCache

open override fun isCompatibleWithConfigurationCache(): Boolean

open override fun mustRunAfter(vararg paths: Any): Task

notCompatibleWithConfigurationCache

open override fun notCompatibleWithConfigurationCache(reason: String)

open override fun onlyIf(onlyIfClosure: Closure<Any>)

open override fun onlyIf(spec: Spec<in Task>)

open override fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)

prependParallelSafeAction

open override fun prependParallelSafeAction(action: Action<in Task>)

open override fun property(propertyName: String): Any?

open override fun setActions(replacements: MutableList<Action<in Task>>)

open override fun setDependsOn(dependsOn: MutableIterable<*>)

open override fun setDescription(description: String?)

open override fun setDidWork(didWork: Boolean)

open override fun setFinalizedBy(finalizedByTasks: MutableIterable<*>)

open override fun setGroup(group: String?)

setMustRunAfter

open override fun setMustRunAfter(mustRunAfterTasks: MutableIterable<*>)

open override fun setOnlyIf(onlyIfClosure: Closure<Any>)

open override fun setOnlyIf(spec: Spec<in Task>)

open override fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)

open override fun setProperty(name: String, value: Any)

setShouldRunAfter

open override fun setShouldRunAfter(shouldRunAfterTasks: MutableIterable<*>)

open override fun shouldRunAfter(vararg paths: Any): TaskDependency

open override fun usesService(service: Provider<out BuildService<*>>)

validateIntelliJPlatformVersion

open fun validateIntelliJPlatformVersion()

Validates that the resolved IntelliJ Platform is supported by checking against the minimal supported IntelliJ Platform version.

fun verifyPlugin()